/*
 * Copyright 2009-2010 the original author or authors.
 *
 * Licensed under the Apache license, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.internna.iwebjtracker.activity;

import java.util.List;
import org.internna.iwebjtracker.activity.model.RecordedActivity;
import org.internna.iwebjtracker.project.model.IWebJTrackerUser;

/**
 * A store of activities.
 *
 * @author Jose Noheda
 * @since 1.0
 */
public interface ActivityHolder<T extends RecordedActivity, U extends IWebJTrackerUser> {

    /**
     * Saves an activity for later inspection.
     *
     * @param activity any
     */
    void store(T activity);

    /**
     * Retrieves all the activities that have happened ordered by time.
     *
     * @return a non null collection.
     */
    List<T> getPerformedActivities();

    /**
     * Cleans the group of activities usually after being processed.
     */
    void clear();

    /**
     * Creates and stores a new activity.
     *
     * @param type any
     * @param user any
     * @return any
     */
    T createActivity(RecordedActivity.ActivityType type, U user);

}
